---
layout: m1x_soap
title: Shipment Info
---

<h2><a name="sales_order_shipment.info-Module%3AMageSales"></a>Module: Mage_Sales</h2>


<h4><a name="sales_order_shipment.info-Resource%3Asalesordershipment"></a>Resource: sales_order_shipment</h4>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_shipment</li>
</ul>


<h5><a name="sales_order_shipment.info-Method%3A"></a>Method:</h5>

<ul>
	<li>sales_order_shipment.info (SOAP V1)</li>
	<li>salesOrderShipmentInfo (SOAP V2)</li>
</ul>


<p>Allows you to retrieve the shipment information.</p>

<p><b>Aliases</b>:</p>
<ul>
	<li>order_shipment.info</li>
</ul>



<p><b>Arguments</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string </td>
<td> shipmentIncrementId <br class="atl-forced-newline" /> </td>
<td> Order shipment increment ID </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of salesOrderShipmentEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderShipmentEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Shipment increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_id <br class="atl-forced-newline" /> </td>
<td> Store ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of shipment creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of shipment updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_address_id <br class="atl-forced-newline" /> </td>
<td> Shipping address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> Order ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> total_qty <br class="atl-forced-newline" /> </td>
<td> Total quantity of items to ship </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipment_id <br class="atl-forced-newline" /> </td>
<td> Shipment ID </td>
</tr>
<tr>
<td> array </td>
<td> items <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderShipmentItemEntity </td>
</tr>
<tr>
<td> array </td>
<td> tracks <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderShipmentTrackEntity </td>
</tr>
<tr>
<td> array </td>
<td> comments <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderShipmentCommentEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderShipmentItemEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sku <br class="atl-forced-newline" /> </td>
<td> Shipment item SKU </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> Shipment item name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_item_id <br class="atl-forced-newline" /> </td>
<td> Order item ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> product_id <br class="atl-forced-newline" /> </td>
<td> Product ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weight <br class="atl-forced-newline" /> </td>
<td> Weight </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> qty <br class="atl-forced-newline" /> </td>
<td> Quantity of items </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> item_id <br class="atl-forced-newline" /> </td>
<td> Item ID </td>
</tr>
</tbody></table>


<p>The <b>salesOrderShipmentTrackEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of tracking number creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> updated_at <br class="atl-forced-newline" /> </td>
<td> Date of tracking number updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> carrier_code <br class="atl-forced-newline" /> </td>
<td> Carrier code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> title <br class="atl-forced-newline" /> </td>
<td> Track title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> number <br class="atl-forced-newline" /> </td>
<td> Tracking number </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> Order ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> track_id <br class="atl-forced-newline" /> </td>
<td> Track ID </td>
</tr>
</tbody></table>


<p>The <b>salesOrderShipmentCommentEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of comment creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment <br class="atl-forced-newline" /> </td>
<td> Shipment comment text </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_customer_notified <br class="atl-forced-newline" /> </td>
<td> Defines whether the customer is notified </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment_id <br class="atl-forced-newline" /> </td>
<td> Comment ID </td>
</tr>
</tbody></table>



<h4><a name="sales_order_shipment.info-Examples"></a>Examples</h4>

<h5><a name="sales_order_shipment.info-RequestexampleSOAPV1"></a>Request example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');
$session = $client-&gt;login('apiUser', 'apiKey');
$result = $client-&gt;call($session, 'sales_order_shipment.info', '200000003');
var_dump($result);</pre>
		</div>
</div></div>

<h5><a name="sales_order_shipment.info-RequestexampleSOAPV2"></a>Request example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;salesOrderShipmentInfo($sessionId, '200000003');
var_dump($result);</pre>
		</div>
</div></div>



<h5><a name="sales_order_shipment.info-RequestexampleSOAPV2%28WSIComplianceMode%29"></a>Request example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;salesOrderShipmentInfo((object)array('sessionId' =&gt; $sessionId-&gt;result, 'shipmentIncrementId' =&gt; '200000003'));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>


